
	  ################################################################
	  ###  peekAboo Media by TINK-RS				  ##
	  ###  A girl who loves Conky & Coding				  ##	
	  ###								  ##
	  ###  GNU GPLv3 - 2022-12-14					  ##
	  ###  https://www.gnu.org/licenses/gpl.html			  ##
	  ################################################################


I cannot guarentee this will work for you on your particular linux system.
But it was coded with love & care, so it should work for the vast majority "out-of-the-box" 
I originally wrote this code for myself and am sharing from the kindness of my heart.


If you enjoy this conky pls come back to pling and leave a rating or a comment.
Super appreciate it!!! Thanks. :)


-----------------IMPORTANT--------------------------

DEPENDENCY: Playerctl

This conky accesses playerctl metadata to display currently playing media. If playerctl "sees" your media player, this conky will display it.
This conky DOES NOT provide cover art. It displays it if available.
If cover art is provided by your player and/or personal music files, it will display in the conky. 
Chrome & Chromium browsers DO NOT supply cover art. See notes below. Only FIREFOX provides cover art.

If cover art is not available, an icon will display in it's place.





----------------- SET UP --------------------------

1. You must install playerctl for this conky to work. Playerctl is a light-weight terminal run media control. This is what the conky uses to retrieve metadata.

Debian/Ubuntu: sudo apt install playerctl
CentOS/Fedora: sudo yum makecache --refresh  THEN ENTER: sudo yum -y install playerctl
Arch: pacman -S playerctl


2.  Place the FOLDER "peekAboo-media" into your .conky folder in your Home directory.

    Eg. $Home/.conky/peekAboo-media/

If you place this folder into a subfolder of $HOME/.conky or any folder other than $HOME/.conky the script will break.
If you remove the files from the peekAboo-media folder, the script will break.
In that case, you have to append every file path in this conky to make it work.

** Use a proper text editor such as gedit or Gnome editor AND use the "find and replace" tool to edit the paths. **


3.  The media.sh file needs to be executable. Pls chmod +x it in terminal OR right click on the file, select properties, click permissions tab and check "allow executing file as program"

4. FONTS - If the font won't display then you must install them on your system. Place them in your .fonts folder, double click each one to "install", then open terminal and enter: "fc-cache -fv" (without the quotes) to refresh your font cache. Next, in Conky Manager hit the X to stop all running widgets, then re-enable the widget - fonts will now show.

----------------- CHANGE ICONS --------------------------

4.  DO NOT edit the ${image} tags in conkyrc to change the default icon!!! 
To change the default icon simply rename the icon you want to use to "active.png
Go into the "icons" folder. Rename the icon currently named "active.png" to anything. eg. old name "active.png" new name "green.png". Then rename the .png image you want to use as "active.png". The icon and cover art are dynamically created by the script to display in the ${image} tag.


----------------- COVER ART --------------------------

When playing web-based media players: ie: spotify, youtube, rumble, etc...

Chrome and Chromium based browsers DO NOT provide cover art, though they do provide all other metadata. This is Chrome's shortcoming, not playerctl or this conky. 

To see the COVER ART for any web based players, USE FIREFOX.

VLC - VLC does a lot of weirdness to the tmp file names it uses to supply cover art. It may or maynot work for you or may display coverart randomly.

When playing personal music/media files: if your music/media files do not have cover art included with them, then this conky cannot display them.


7. Enjoy!


